/**
 * Copyright 2010 Tristan Slominski
 *
 * Licensed under the MIT License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.opensource.org/licenses/mit-license.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mindash.handlebars.client.wrappers;

import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.ui.Widget;

/**
 * @author Tristan Slominski
 * 
 */
public interface RootPanelWrapper {

  /**
   * Custom addition to root panel to keep track of the page that gets added.
   * This allows for messaging and other popup services to work across pages as
   * they get reloaded!
   * 
   * @param pageView the page view to set
   */
  public void addPage(Widget pageView);

  /**
   * Clears the added page view without disturbing any messaging panels that are
   * added.
   */
  public void clearPage();

  public void detachNow(Widget widget);

  public void detachOnWindowClose(Widget widget);

  public void ensureDebugId(Element elem, String id);

  public com.google.gwt.user.client.ui.RootPanel get();

  public com.google.gwt.user.client.ui.RootPanel get(String id);

  public Element getBodyElement();

  public boolean isInDetachList(Widget widget);

  public boolean isVisible(Element elem);

  public void setVisible(Element elem, boolean visible);

}
